home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / man / cat.1 / makeinfo.1 < prev    next >
Text File  |  1995-07-25  |  13KB  |  265 lines
  1.  
  2.  
  3.  
  4.      mmmmaaaakkkkeeeeiiiinnnnffffoooo((((1111))))           GGGGNNNNUUUU TTTToooooooollllssss ((((3333mmmmaaaarrrr1111999999992222))))            mmmmaaaakkkkeeeeiiiinnnnffffoooo((((1111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           makeinfo - build GNU info files
  10.  
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           mmmmaaaakkkkeeeeiiiinnnnffffoooo
  14.                [----IIII _d_i_r] [----DDDD _v_a_r] [----UUUU _v_a_r] [--------eeeerrrrrrrroooorrrr----lllliiiimmmmiiiitttt _n_u_m | ----eeee _n_u_m]
  15.                [--------ffffiiiillllllll----ccccoooolllluuuummmmnnnn _n_u_m | ----ffff _n_u_m]
  16.                [--------ffffoooooooottttnnnnooootttteeee----ssssttttyyyylllleeee _s_t_y_l_e | ----ssss _s_t_y_l_e] [--------nnnnoooo----hhhheeeeaaaaddddeeeerrrrssss]
  17.                [--------nnnnoooo----sssspppplllliiiitttt] [--------nnnnoooo----vvvvaaaalllliiiiddddaaaatttteeee | --------nnnnoooo----ppppooooiiiinnnntttteeeerrrr----vvvvaaaalllliiiiddddaaaatttteeee]
  18.                [--------nnnnoooo----wwwwaaaarrrrnnnn]
  19.                [--------nnnnoooo----nnnnuuuummmmbbbbeeeerrrr----ffffoooooooottttnnnnooootttteeeessss | --------nnnnuuuummmmbbbbeeeerrrr----ffffoooooooottttnnnnooootttteeeessss]
  20.                [--------oooouuuuttttppppuuuutttt _f_i_l_e | ----oooo _f_i_l_e]
  21.                [--------ppppaaaarrrraaaaggggrrrraaaapppphhhh----iiiinnnnddddeeeennnntttt _n_u_m | ----pppp _n_u_m]
  22.                [--------rrrreeeeffffeeeerrrreeeennnncccceeee----lllliiiimmmmiiiitttt _n_u_m | ----rrrr _n_u_m] [--------vvvveeeerrrrbbbboooosssseeee]
  23.                [--------vvvveeeerrrrssssiiiioooonnnn | ----VVVV]
  24.  
  25.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  26.           mmmmaaaakkkkeeeeiiiinnnnffffoooo is a program for converting _t_e_x_i_n_f_o files into _i_n_f_o
  27.           files.   Texinfo  is a documentation language which allows a
  28.           printed manual and online documentation (an info file) to be
  29.           produced  from  a  single  source  file.  _i_n_f_o files contain
  30.           structured markers to permit easy online navigation  of  the
  31.           documentat.
  32.  
  33.           See _T_e_x_i_n_f_o, _t_h_e _G_N_U _D_o_c_u_m_e_n_t_a_t_i_o_n _F_o_r_m_a_t for details on how
  34.           to write a texinfo file.
  35.  
  36.  
  37.      OOOOPPPPTTTTIIIIOOOONNNNSSSS
  38.           ----IIII _d_i_r
  39.                Adds _d_i_r to the directory search list for finding files
  40.                that are included using the `@include' command.  By de-
  41.                fault, mmmmaaaakkkkeeeeiiiinnnnffffoooo searches only the current directory.
  42.  
  43.  
  44.           ----DDDD _v_a_r
  45.                Defines the texinfo flag _v_a_r.  This  is  equivalent  to
  46.                `@set _v_a_r' in the Texinfo file.
  47.  
  48.  
  49.           ----UUUU _v_a_r
  50.                Makes  the  texinfo  flag  _v_a_r  undefined.    This   is
  51.                equivalent to `@clear _v_a_r' in the Texinfo file.
  52.  
  53.  
  54.           --------eeeerrrrrrrroooorrrr----lllliiiimmmmiiiitttt _n_u_m | ----eeee _n_u_m
  55.                Sets the maximum number of errors that mmmmaaaakkkkeeeeiiiinnnnffffoooo  prints
  56.                before exiting (on the assumption that continuing would
  57.                be useless).  The default number of errors that can  be
  58.                printed  before mmmmaaaakkkkeeeeiiiinnnnffffoooo gives up on processing the in-
  59.                put file is 100.
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 7/12/95)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      mmmmaaaakkkkeeeeiiiinnnnffffoooo((((1111))))           GGGGNNNNUUUU TTTToooooooollllssss ((((3333mmmmaaaarrrr1111999999992222))))            mmmmaaaakkkkeeeeiiiinnnnffffoooo((((1111))))
  71.  
  72.  
  73.  
  74.           --------ffffiiiillllllll----ccccoooolllluuuummmmnnnn _n_u_m | ----ffff _n_u_m
  75.                Specifies the maximum right-hand edge of a line.  Para-
  76.                graphs  that  are  filled will be filled to this width.
  77.                The default value for fill-column is 72.
  78.  
  79.  
  80.           --------ffffoooooooottttnnnnooootttteeee----ssssttttyyyylllleeee _s_t_y_l_e | ----ssss _s_t_y_l_e
  81.                Sets the footnote style to _s_t_y_l_e.  _s_t_y_l_e should  either
  82.                be  `sssseeeeppppaaaarrrraaaatttteeee'  to have mmmmaaaakkkkeeeeiiiinnnnffffoooo create a separate node
  83.                containing the footnotes for the current node, or `eeeennnndddd'
  84.                to  have mmmmaaaakkkkeeeeiiiinnnnffffoooo place the footnotes at the end of the
  85.                current node.
  86.  
  87.  
  88.           --------nnnnoooo----hhhheeeeaaaaddddeeeerrrrssss
  89.                Do not generate menus or node headers.  This option  is
  90.                useful  together  with  the  `--------oooouuuuttttppppuuuutttt _f_i_l_e' and `--------nnnnoooo----
  91.                sssspppplllliiiitttt' options  to  produce  a  simple  formatted  file
  92.                (suitable  for printing on a dumb printer) from Texinfo
  93.                source.  If you do not have TeX, these options may  al-
  94.                low you to get readable hard copy.
  95.  
  96.           --------nnnnoooo----sssspppplllliiiitttt
  97.                Suppress the splitting stage of mmmmaaaakkkkeeeeiiiinnnnffffoooo.  In  general,
  98.                large  output  files  are  split into smaller subfiles,
  99.                each one  approximately  50k  bytes.   If  you  specify
  100.                --------nnnnoooo----sssspppplllliiiitttt, mmmmaaaakkkkeeeeiiiinnnnffffoooo will not split up the output file.
  101.  
  102.  
  103.           --------nnnnoooo----vvvvaaaalllliiiiddddaaaatttteeee | --------nnnnoooo----ppppooooiiiinnnntttteeeerrrr----vvvvaaaalllliiiiddddaaaatttteeee
  104.                Suppress the validation phase of  mmmmaaaakkkkeeeeiiiinnnnffffoooo.   Normally,
  105.                after  the  file  is processed, some consistency checks
  106.                are  made  to  ensure  that  cross  references  can  be
  107.                resolved, etc.
  108.  
  109.  
  110.           --------nnnnoooo----wwwwaaaarrrrnnnn
  111.                Suppress the output of warning messages.  This does _n_o_t
  112.                suppress the output of error messages, simply warnings.
  113.                You might want this if the file you  are  creating  has
  114.                texinfo  examples  in it, and the nodes that are refer-
  115.                enced don't actually exist.
  116.  
  117.  
  118.           --------nnnnoooo----nnnnuuuummmmbbbbeeeerrrr----ffffoooooooottttnnnnooootttteeeessss
  119.                Supress the automatic numbering of footnotes.  The  de-
  120.                fault is to number each footnote sequentially in a sin-
  121.                gle node, resetting the current footnote number to 1 at
  122.                the start of each node.
  123.  
  124.  
  125.           --------nnnnuuuummmmbbbbeeeerrrr----ffffoooooooottttnnnnooootttteeeessss
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 7/12/95)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      mmmmaaaakkkkeeeeiiiinnnnffffoooo((((1111))))           GGGGNNNNUUUU TTTToooooooollllssss ((((3333mmmmaaaarrrr1111999999992222))))            mmmmaaaakkkkeeeeiiiinnnnffffoooo((((1111))))
  137.  
  138.  
  139.  
  140.                Explicitly request that footnotes be numbered, as  they
  141.                are by default.
  142.  
  143.  
  144.           --------oooouuuuttttppppuuuutttt _f_i_l_e | ----oooo _f_i_l_e
  145.                Write the output in the _f_i_l_e specified, instead  of  in
  146.                the  name  specified  in the texinfo file itself.  _f_i_l_e
  147.                can be the special token `----', which specifies  standard
  148.                output.
  149.  
  150.  
  151.           --------ppppaaaarrrraaaaggggrrrraaaapppphhhh----iiiinnnnddddeeeennnntttt _n_u_m | ----pppp _n_u_m
  152.                Sets the paragraph indentation to _n_u_m.   The  value  of
  153.                _n_u_m is interpreted as follows:
  154.  
  155.                A value of 0 means don't change the  existing  indenta-
  156.                tion at the starts of paragraphs.
  157.  
  158.                A value less than zero means indent paragraph starts to
  159.                column zero by deleting the existing indentation.
  160.  
  161.                A value greater than zero is the number  of  spaces  to
  162.                leave at the front of each paragraph start.
  163.  
  164.  
  165.           --------rrrreeeeffffeeeerrrreeeennnncccceeee----lllliiiimmmmiiiitttt _n_u_m | ----rrrr _n_u_m
  166.                Issue a warning if any single node is  referenced  more
  167.                than  _n_u_m  times  in the info file.  The default _n_u_m is
  168.                1000.
  169.  
  170.  
  171.           --------vvvveeeerrrrbbbboooosssseeee
  172.                Causes mmmmaaaakkkkeeeeiiiinnnnffffoooo to inform you as to what it  is  doing.
  173.                Normally mmmmaaaakkkkeeeeiiiinnnnffffoooo only outputs text if there are errors
  174.                or warnings.
  175.  
  176.  
  177.           --------vvvveeeerrrrssssiiiioooonnnn | ----VVVV
  178.                Prints out the version number of mmmmaaaakkkkeeeeiiiinnnnffffoooo.
  179.  
  180.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  181.           iiiinnnnffffoooo(1111); the `tttteeeexxxxiiiinnnnffffoooo', `iiiinnnnffffoooo', and `mmmmaaaakkkkeeeeiiiinnnnffffoooo'  info  nodes;
  182.           and   _T_e_x_i_n_f_o,  _t_h_e  _G_N_U  _D_o_c_u_m_e_n_t_a_t_i_o_n  _F_o_r_m_a_t,  by  Robert
  183.           Chassell and Richard Stallman.
  184.  
  185.      AAAAUUUUTTTTHHHHOOOORRRR
  186.           Brian Fox wrote and maintains mmmmaaaakkkkeeeeiiiinnnnffffoooo.
  187.  
  188.      CCCCOOOOPPPPYYYYIIIINNNNGGGG
  189.           Copyright (c) 1992, 1993 Free Software Foundation, Inc.
  190.  
  191.           Permission is granted to make and distribute verbatim copies
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 7/12/95)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      mmmmaaaakkkkeeeeiiiinnnnffffoooo((((1111))))           GGGGNNNNUUUU TTTToooooooollllssss ((((3333mmmmaaaarrrr1111999999992222))))            mmmmaaaakkkkeeeeiiiinnnnffffoooo((((1111))))
  203.  
  204.  
  205.  
  206.           of  this  manual provided the copyright notice and this per-
  207.           mission notice are preserved on all copies.
  208.  
  209.           Permission is granted to copy and distribute  modified  ver-
  210.           sions of this manual under the conditions for verbatim copy-
  211.           ing, provided that the entire resulting derived work is dis-
  212.           tributed under the terms of a permission notice identical to
  213.           this one.
  214.  
  215.           Permission is granted to copy and distribute translations of
  216.           this  manual  into  another language, under the above condi-
  217.           tions for modified versions, except that this permission no-
  218.           tice  may  be  included in translations approved by the Free
  219.           Software Foundation instead of in the original English.
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                                          (printed 7/12/95)
  262.  
  263.  
  264.  
  265.